#-*- coding: utf-8 -*-

#This file is part of pyLot library.
#
# pyLot is free software: you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# pyLot is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with pyLot.  If not, see <http://www.gnu.org/licenses/>.

__author__ = u'Pierre Puiseux, Guillaume Baty'
__copyright__ = u"Copyright 2011-2012 (C) andheo, Université de Pau et des Pays de l'Adour"
__credits__ = [u'Pierre Puiseux', u'Guillaume Baty']
__license__ = "GNU Lesser General Public License"

#-*- coding: utf-8 -*-

__all__ = [u'IHandler']

from traits.api import Str, Unicode, Python
from ..interfaces.i_basehandler import IBaseHandler

class IHandler(IBaseHandler):
  """
  Based on IBaseHandler, this interface adds fields to identify this handler
  among other and describe it.
  
  Such information is typically used by "marketplace", "app stores",
  "help" or "list" commands.
  
  For example:
  print_available_extensions() may print a list of
  (using developer point of view) 
  "IHandler.alias (IHandler.identifier) : IHandler.desc".

  (using user point of view) 
  Simple Calculator (pyLot.handler.calculator) : A "GÉNIAL" calculator able to compute a+b and a-b, 
  """

  """Human readable name. This string may be translated or changed so do not
  use it as reference or input but only for display purposes.
  For example, for a simple calculator, identifier should be 
  "pyLot.toolwidget.calculator" and alias "Simple Calculator" """
  alias = Unicode
  """Unique identifier. You should use convention "module.interface.name" 
  For example 'pyLot.handler.calculator' """
  identifier = Str
  """Object description"""
  desc = Unicode


if __name__ == '__main__' :
  pass
